home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Monster Media 1996 #14
/
Monster Media No. 14 (April 1996) (Monster Media, Inc.).ISO
/
rem_acc
/
q_a4ra11.zip
/
QUESTAIR.Q&A
< prev
next >
Wrap
Text File
|
1996-02-04
|
20KB
|
578 lines
▄█████▄ ▄▀▀▄ ▄█████▄ ▐█ ██ ██████▄ ▄█████▄
██ ██ ▀▄▄▀ ██▄▄▄██ ██▄▄██▄ ██ ██ ██▄▄▄██
██ ▀▄██ ▄▀ ▀▄▀ ██▀▀▀██ ▀▀▀▀██▀ ██████ ██▀▀▀██
▀████▀▄ ▀▄ ▄▀▄ ██ ██ ██ ██ ▀██ ██ ██
▀▀ ▀
Revision 11
Questions and Answers for RemoteAccess 2.x
░░▒▒▓▓ QUESTAIR.Q&A ▓▓▒▒░░
Updated on 02/04/96
By: Eric Staufer
The Concession Stand
FidoNet 1:374/6568
Topics: Keywords:
──────────────────────────────────────────┼─────────────────────────
o What can you do with a Questionnaire? ..... ** WHAT **
o General Parts of a Questionnaire .......... ** PARTS **
o Ask ................................ ** ASK **
o Assign ............................. ** ASSIGN **
o Capitalise ......................... ** CAPITAL **
o Commit ............................. ** COMMIT **
o ChangeColor ........................ ** COLOR **
o ClearScreen ........................ ** CLEAR **
o DefineOutput ....................... ** DEFINE **
o Display ............................ ** DISPLAY **
o DisplayFile ........................ ** DISPLAYFILE **
o EndIf .............................. ** ENDIF **
o Exec ............................... ** EXEC **
o GetChoice .......................... ** GETCHOICE **
o Goto ............................... ** GOTO **
o If ................................. ** IF **
o ListAnswer ......................... ** LISTANSWER **
o MenuCmnd ........................... ** MENUCMND **
o OutputAnswer ....................... ** OUTPUT **
o PostInfo ........................... ** POSTINFO **
o Quit ............................... ** QUIT **
o SetFlag ............................ ** FLAG **
o SetSecurity ........................ ** SECURITY **
o WaitEnter .......................... ** WAITENTER **
o HardCoded Questionnaires .................. ** HARDCODED **
** WHAT **
What is a Questionnaire?
─────────────────────────
A Questionnaire (Q-A) is a script language file for RemoteAccess. You can
ask questions within a questionnaire, and depending on the responce of a
certain questionnaire, you can upgrade their security, give them certain
flags, execute certain menu commands, and execute programs, or do the
opposite of the above. Some people have even been known to create little
programs with these questionnaires.
Though, most of the SysOps use Questionnaires to obtain information from
their users on their BBS, using them as polls and newuser questionnaires.
For more information about 'What is a Questionnaire?' check page #236 of
the RemoteAccess Documentation.
** PARTS **
General Parts of a Questionnaire
─────────────────────────────────
Listed below in their each section are the different actions of a
questionnaire file.
I am not going to copy WORD for WORD from the RA.DOC.
At the top of the header for each action, I will make a note saying:
'See Page #xxx / RA.DOC " For more information concerning the
specific action.
** ASK **
Ask See Page #239 / RA.DOC
──── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: ASK <length> <variable #>
Desc: Prompts the user to input an answer into the <length> field.
The <variable #> is what to store the inputted information as.
Example: Ask 35 1
In the above example, a user would have upto 35 characters to
write down the answer to a question. The inputted information
would be stored as variable #1.
Assign See Page #239 / RA.DOC
─────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: ASSIGN <variable #> <"text">
Desc: This stores the <"text"> of what you specified on the command line
as a specific variable number.
o Notice that the "text" must be in quotation marks.
o Control Codes may be used in the place of the "text", but
control codes do not need to be in quotation marks.
Example: Assign 3 "Hello"
This would simply store the word 'Hello' as variable #3.
** CAPITAL **
Capitalise See Page #239 / RA.DOC
─────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: CAPITALISE <ON/OFF>
Desc: Turns on or off auto input capitalization.
Default mode in a questionnaire is OFF.
Example: Capitalise ON
This would force the user's input to be all capitalized.
To turn it back to normal mode, just use a Capitalise OFF.
** COMMIT ** See Line #133 / WHATSNEW.250
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Commit
───────
Syntax: COMMIT
Desc: Immediately writes the answers to the output (answer) file.
Instead of waiting for the questionnaire to be completed before
writing all of the answers to the output file, with this new
command, it will immediately add the answers to the output file.
Example: Commit
** COLOR **
ChangeColor See Page #240 / RA.DOC
──────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: CHANGECOLOR <foreground> <background>
Desc: Changes the color of the text, if the user has ANSi capabilities.
The Color Codes are on page #181.
Example: ChangeColor 10 0
This would change the text color to Bright Green on a Black
Background.
** CLEAR **
ClearScreen See Page #240 / RA.DOC
──────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: CLEARSCREEN
Desc: Clears the Screen if the user has screen clearing codes enabled.
Example: ClearScreen
Would simply clear the user's screen.
** DEFINE ** See Line #139 / WHATSNEW.250
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
DefineOutPut
─────────────
Syntax: DefineOutPut c:\path\to\output.txt
Desc: This command which is optional, will put all of the output from
the questionnaire into the specified file and path.
Normally, if this command is not specified, RA will automatically
generate the output file as the name of the questionnaire with
the ASW extension and would be found in RA's system directory.
Example: DefineOutPut C:\RA\QA\SAMPLE.ASW
This would put all of the output into a file called SAMPLE.ASW
in the speficized directory.
** DISPLAY **
Display See Page #240 / RA.DOC
──────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: DISPLAY "<text> [ | ] "
Desc: Displays the given "text" to the user online.
o That the <text> MUST be in quotes!
o The pipe '|' symbol is used as a carriage return.
Example: Display "Hello there! |"
Displays the line "Hello there! " to the user. And since
we used a pipe in the statement, it will automatically
goto the next line after the line is displayed.
** DISPLAYFILE **
DisplayFile See Page #241 / RA.DOC
──────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: DISPLAYFILE <basename>
Desc: This displays a textfile to the user. All you need to remember
is that after the command "DisplayFile" you must only write down
the basefile name of the file .. DO NOT INCLUDE THE EXTENSION.
Also, the textfile must reside in your textfiles directory.
Example: DisplayFile BBSRULES
This would display the file BBSRULES to the user.
** ENDIF **
EndIf See Page #241 / RA.DOC
───── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: ENDIF
Desc: Used in conjunction with the "IF" command, it signifies the
end to the if statement.
Example: Please see the IF section.
** EXEC **
Exec See Page #241 / RA.DOC
───── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: EXEC <command line>
Desc: Runs an external protocol. Similiar to the Type 7 menu command.
All external parameters are allowed (ie *N, *M, etc..)
Example: C:\RA\SEARCH.EXE *M
Would execute the program SEARCH.EXE from the C:\RA directory.
*M is used to swap RemoteAccess out of memory.
** GETCHOICE **
GetChoice See Page #242 / RA.DOC
────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: GETCHOICE <choices> <variable #>
Desc: Waits for the user to enter one of the valid <choices>.
And it stores the responce in the <variable #>.
Example: GetChoice YN 3
Waits for the user to enter "Y" or "N", and stores the
input into variable #3.
** GOTO **
Goto See Page #242 / RA.DOC
───── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: GOTO <label>
Desc: Causes the script to jump to the <label>.
Please note that the label must be preceded by a colon ':'
Example: If 3 = "Y"
Goto YES
EndIf
:YES
Display "Here we are."
Quit
In this example, if variable #3 equaled "Y" then it would
GOTO the <label> called YES and then it would continue
processing.
** IF **
If See Page #242-244 / RA.DOC
─── ~~~~~~~~~~~~~~~~~~~~~~~~~~
(I've taken this directly from the RA.DOC, I didnt want to even try to
rewrite this one...)
Syntax: IF <var num[~]> <operator> <operand>
Desc: This command is used to perform comparisons
within your script file and take actions based
on the results of the comparisons. The result
of an IF comparison is considered to be either
true or false. If the comparison is found to
be true, then all lines up to the next EndIF
are processed by the interpreter. In case you
aren't familiar with logical comparisons,
refer to the examples listed below and later
in this chapter. They will help you to better
understand the purpose and functionality of
this command.
Specifically, this command compares the
contents of the variable <var num> with the
contents of <operand> using the type of
comparison specified in <operator>.
<Var num> may be any variable number between 1
and 50 followed by the optional numeric
identifier "~". When a tilde character "~" is
specified after <var num> it indicates that a
numeric comparison is to be made instead of a
text string comparison.
<Operator> may be any combination of:
= Equal to...
< Less than...
> Greater than...
<Operand> values may be:
* Literal text enclosed in quotation marks.
* A variable number specified as <#var num>.
* Any text file control code.
When comparing the contents of a variable
specified as <var num> with the contents of
another variable specified as <operand>, the
<operand> variable number must be preceded by
the # character.
NOTE: This command may not be nested. That is to say that
you cannot use an IF command between other IF and EndIF
commands.
Examples: IF 1 <> #2
Would return true if the contents of variable
number one was not equal to the contents of
variable number 2.
IF 5~ <= ^KO
Would return true if the value of variable
number five was less than or equal to the
user's time remaining. Notice that the "~"
was used to indicate that a numeric comparison
was to be made. Also notice the usage of the
text file control code that returns the user's
time remaining.
IF 5 = "LUXEMBOURG"
Display "Hey, that's where I live!|"
EndIF
In this example, the interpreter would check
to see if variable number 5 was equal to the
string LUXEMBOURG. If true, the text "Hey,
that's where I live!" would be displayed. If
the contents of variable number 5 did not
match, the statement would have been
considered to be false and the interpreter
would jump to the EndIF statement.
IF 1 <> #2
Display "Variables 1 and 2 are different!|"
EndIF
In this example, the contents of variable
numbers one and two would be compared. If
they were not equal, the text "Variables 1 and
2 are different!" would be displayed.
** LISTANSWER **
ListAnswer See Page #244 / RA.DOC
─────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: LISTANSWER <variable #>
Desc: Displays the content of a variable number <variable #> followed
by a carriage return and line feed.
Example: Display "Please Enter Your Name: "
Ask 35 1
Display "You Entered: " ListAnswer 1
In this example, it will show the user what he or she entered
after the question "Please Enter Your Name: "
** MENUCMND **
MenuCmnd See Page #244 / RA.DOC
───────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: MENUCMND <number> <opt. data>
Desc: Executes the menu command specified, followed by the optional
data information.
Example: MenuCmnd 27 1 /T=Eric_Staufer
This would post a message to Eric Staufer in message base #1.
Pretty simple, huh?
** OUTPUT **
OutPutAnswer See Page #245 / RA.DOC
───────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: OUTPUTANSWER <"descriptor"> <variable #>
Desc: Writes the literal "text" string specified as <"descriptior">
followed by the contents of the <variable #>.
Example: OutputAnswer "Hobbies : " 2
This would output:
Hobbies: Playing Basketball & Football.
to the answer file <.ASW> of the questionnaire..
** POSTINFO **
PostInfo See Page #246 / RA.DOC
───────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: POSTINFO
Desc: Writes a header file for the Questionnaire ANSWER File (.ASW)
Example: PostInfo
Take for instance John Smith had just completed the questionnaire.
We would see this, in the answer file:
** John Smith completeted questionnaire at 18:00 on 08-Aug-95 **
** QUIT **
Quit See Page #246 / RA.DOC
───── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: QUIT
Desc: Terminates the questionnaire and returns back to the BBS.
Example: Quit
Would quit the questionnaire and return the user back to BBS.
** FLAG **
SetFlag See Page #246 / RA.DOC
──────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: SETFLAG <flagset><flag #> <ON/OFF>
Desc: This command would either turn on or off a specific user flag.
<FlagSet> is either A,B,C,D. And flag # ranges from 1 to 8.
Example: SetFlag B8 ON
This would turn the flag B8 to the ON position.
** SECURITY **
SetSecurity See Page #247 / RA.DOC
──────────── ~~~~~~~~~~~~~~~~~~~~~~
Syntax: SETSECURITY <sec level>
Desc: This command would change the user's security level to the
<sec level> specified.
Example: SetSecurity 100
This would change the user's security level to 100.
** WAITENTER **
WaitEnter
──────────
Syntax: WAITENTER See Page #247 / RA.DOC
~~~~~~~~~~~~~~~~~~~~~~
Desc: This command if specified, will WAIT until the user presses
the ENTER key. Ideal for the Press ENTER to Continue command.
Example: Display "Press [Enter] to Continue:
WaitEnter
This will display the Press [Enter] to Continue string, and then
it will wait until the user presses enter, before continuing.
** HARDCODED **
HardCoded Questionnaires
─────────────────────────
Listed below are the names of the hard-coded questionnaires which
RemoteAccess supports:
DOBCFAIL.Q-A - Used when a user has incorrectly entered their date of
birth at the DOB check. You can use this questionnaire
to downgrade their account, or whatever.
NEWUSER.Q-A - One of the most used questionnaires. This questionnaire
can be used to ask about more information from the user.
Such as where they heard about the board, what kind of
computer they are using, etc..
NOCREDIT.Q-A - This is used with the subscription system. When the
user reaches 0 credits remaining, this questionnaire
comes in effect. It can be used to lower their
security level, or maybe, run an external credit card
door.
SUBDATE.Q-A - This questionnaire is used when the user's subscription
has expired. Again, this can be used to lower the user's
security level, or run an external credit card program.
SUBDAYnn.Q-A - This questionnaire is used as a reminder to a user where
their subscription is about to expire. nn - is the amount
of days before the subscription expiration date.
SUBDAY10.Q-A would be shown 10 days before their
subscription expires.
░░▒▒▓▓ QUESTAIR.Q&A ▓▓▒▒░░
Total Lines: 577 Total Size: 19k
